Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget/ActiveButtonWidget

ActiveButtonWidget

open class ActiveButtonWidget @JvmOverloads constructor(titleSupplier: Supplier<Text>, width: Int, height: Int, activeSupplier: Supplier<Boolean>, pressAction: Consumer<ActiveButtonWidget>, textures: TextureSet = DEFAULT_TEXTURES) : CustomPressableWidget

A Button Widget that can supply its message and active state, and render a custom background

Author

fzzyhmstrs

Since

0.2.0, implements TextureSet for backgrounds 0.6.0

Parameters

titleSupplier

Supplier<Text> - supplies the message/label for this button

width

Int - width of the widget

height

Int - height of the widget

activeSupplier

Supplier - Supplies whether this button is active or not

pressAction

Consumer - action to take when the button is pressed

textures

TextureSet, optional - a custom background texture set; defaults to DEFAULT_TEXTURES

Constructors

ActiveButtonWidget

constructor(title: Text, width: Int, height: Int, background: TextureSet?, activeSupplier: Supplier<Boolean>, pressAction: Consumer<ActiveButtonWidget>)

A Button Widget that can supply its message and active state, and render a custom background

@JvmOverloads

constructor(title: Text, width: Int, height: Int, activeSupplier: Supplier<Boolean>, pressAction: Consumer<ActiveButtonWidget>, background: Identifier? = null)

A Button Widget that can supply its message and active state, and render a custom background

@JvmOverloads

constructor(titleSupplier: Supplier<Text>, width: Int, height: Int, activeSupplier: Supplier<Boolean>, pressAction: Consumer<ActiveButtonWidget>, textures: TextureSet = DEFAULT_TEXTURES)

Properties

active

var active: Boolean

focused

var focused: Boolean

navigationOrder

var navigationOrder: Int

visible

var visible: Boolean

var x: Int

var y: Int

Functions

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

charTyped

open fun charTyped(chr: Char, modifiers: Int): Boolean

drawMessage

open fun drawMessage(context: DrawContext, textRenderer: TextRenderer, x: Int, y: Int, width: Int, height: Int, color: Int)

Draws the widgets message with standard edge padding and positioning.

forEachChild

open override fun forEachChild(consumer: Consumer<ClickableWidget>)

getBottom

open fun getBottom(): Int

getFocusedPath

@Nullable

open fun getFocusedPath(): GuiNavigationPath?

getHeight

open override fun getHeight(): Int

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationPath

@Nullable

open override fun getNavigationPath(navigation: GuiNavigation): GuiNavigationPath?

getRight

open fun getRight(): Int

getTooltip

@Nullable

open fun getTooltip(): Tooltip?

getType

open override fun getType(): Selectable.SelectionType

getWidth

open override fun getWidth(): Int

isHovered

open fun isHovered(): Boolean

isMouseOver

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

isNarratable

open override fun isNarratable(): Boolean

isSelected

open fun isSelected(): Boolean

keyReleased

open fun keyReleased(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

mouseClicked

open override fun mouseClicked(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseDragged

open override fun mouseDragged(mouseX: Double, mouseY: Double, button: Int, deltaX: Double, deltaY: Double): Boolean

mouseMoved

open fun mouseMoved(mouseX: Double, mouseY: Double)

mouseReleased

open override fun mouseReleased(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseScrolled

open fun mouseScrolled(mouseX: Double, mouseY: Double, horizontalAmount: Double, verticalAmount: Double): Boolean

onRelease

open fun onRelease(mouseX: Double, mouseY: Double)

playDownSound

open fun playDownSound(soundManager: SoundManager)

provideNarrationLines

open fun provideNarrationLines(): List<Text>

Provides a list of text for appending into a Narration Hint. By default this will use the same lines passed from provideTooltipLines, with predefined values for the inputs

provideTooltipLines

open fun provideTooltipLines(mouseX: Int, mouseY: Int, parentSelected: Boolean, keyboardFocused: Boolean): List<Text>

Provides a list of text lines for appending to a tooltip. Unlike appending in MC, the parent has final say on compiling the tooltip from the pieces given to it.

render